home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 2 / MacMania 2.toast / Demo's / Tools&Utilities / Netwerk⁄Telecom / Charon 0.98 / Charon Readme < prev   
Encoding:
Text File  |  1993-07-15  |  15.8 KB  |  277 lines  |  [TEXT/ttxt]

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                              CHARON V0.98ß
  10.  
  11.                                      A Freeware fidonet mailer
  12.                                featuring EMSI, YooHoo and ZedZap
  13.                                      (c) Oscar Vermeulen 1993
  14.  
  15.  
  16.  
  17.  
  18. CONTENTS:
  19.  
  20.    * 1. Introduction
  21.    * 2. Configuring Charon
  22.    * 3. Using Charon
  23.    * 3. Some typical setups
  24.    * 4. Some notes for this beta version
  25.  
  26.  
  27.  
  28. ACKS:
  29.  
  30.       Zmodem Sources: Bit Bucket Software Co, the Zmodem code from Binkley 2.50
  31.       EMSI Sources: based on Anthony Rumble's Unix pointmailer NixMail 0.05a
  32.       System 7 and Tough Apple Stuff: Peter Kocourek
  33.       Fido related Expert Advice: Stefan van Dessel
  34.  
  35.  
  36. DISCLAIMER DEPARTMENT:
  37.  
  38. This is an unrestricted beta release of Charon. This version has been tested extensively, however, so it should behave itself reasonably well. Look at chapter 5 if problems do arise. 
  39. Responsibility for damage caused by the use of Charon lies with the user only. No profit may be made by distributing Charon (freeware distributors may not charge more than $6 for the disk that contains Charon, including the disk itself and postage) without prior permission by the author.
  40.  
  41.  
  42. QUESTIONS & COMPLAINTS:
  43.  
  44. Oscar Vermeulen, Hildebrandhove 108, 2726 AZ Zoetermeer, the Netherlands. 
  45. * Phone (voice, no modems, please):  +31-79-213312
  46. * Usenet:  oscar@contrast.wlink.nl (valid until sept.93), Fidonet:  2:281/527.18
  47. Please let me know if something is not working as it should. Even if it does, I LIKE FEEDBACK! :)
  48.  
  49. ----------------------------------------------------------------------------
  50.  
  51.  
  52.  
  53. 1. Introduction.
  54. ==============
  55.  
  56. Charon is a 'freeware' fidonet pointmailer featuring the standard EMSI and YooHoo protocols and fast ZedZap (zmodem) file transfers. It is designed to be used together with CounterPoint or Alice (v2.21 upwards), or to serve as a replacement for MacWoof's built-in mailer. Other message editors should work as well. 
  57.  
  58. Some pro's of Charon:
  59. 1) Up-to-date connects with DOS-based mailers, using EMSI (multi-address 
  60.     ability for those who need it) and efficient, reliable ZedZap transfers, 
  61. 2) no shareware fee, 
  62. 3) extremely simple to install and use.
  63.  
  64. Some cons:
  65. 1) a pointmailer is only useful for point setups: it will NOT answer incoming calls. 
  66. 2) this is a beta release, so there should be a few bugs and imperfections.
  67. 3) no FTS-0001 support. FTS-0001 was the original Xmodem based fidonet protocol,
  68.     which was replaced by YooHoo and EMSI some years ago. 
  69.  
  70. The third point may need some elaboration. To my knowledge, Tabby is the only mailer that still requires FTS-0001. However, Tabby is more or less obsolete now that Formula 1 is here, so I'm not bothered too much by this incompatibility. Also, MacWoof already is a near perfect FTS-0001 mailer if you do need to connect with Tabby. Charon has been tested successfully with practically every other mailer in use today. 
  71.  
  72.  
  73. The Charon & Obolus combo:
  74. -------------------------
  75. Obolus is a mail exporter developed by Peter Kocourek. Charon can use it to automatically extract the messages you wrote in CounterPoint, before dialing your boss. Obolus makes Charon and CounterPoint a highly integrated setup. In everyday use, it runs almost invisibly from within Charon. Its use is entirely optional, but recommended.
  76.  
  77.  
  78. Babble:
  79. -------
  80. Charon was bolted together as a piece of freeware using the following sources:
  81.  
  82.    Zmodem Sources: Bit Bucket Software Co, the Zmodem code from Binkley 2.50
  83.    EMSI Sources: Anthony Rumble, from his excellent Unix pointmailer NixMail 0.05a
  84.  
  85. A Big Thank You to these authors for making their sources freely available. In accordance with their Copyleft scheme, Charon's sources are available from me upon request, with the provision that you do not use them to make another pointmailer. Let me warn you that the sources do look like what they are, a kludge...
  86. Thanks also to Peter Kocourek, for providing me with some of the toughest Mac code in Charon, and for writing Obolus. Experts in Greek mythology will not be surprised that Charon and Obolus were developed to work together. They will also know our opinion regarding the DOS-based world on the other side of the phone line...
  87.  
  88.  
  89. ----------------------------------------------------------------------------
  90.  
  91.  
  92.  
  93.  
  94. 2. Configuring Charon:
  95. ====================
  96.  
  97. The basic idea behind Charon is very simple -- Charon sends all files (normally, .pkt files) that are placed in an outbound folder to its Boss, and puts all files offered by its Boss in an inbound folder. A configuration file is used to store all necessary information.
  98.  
  99. To install Charon:
  100. 1) Select 'Add a new Boss' in the File menu to create a config file.
  101.     . If you have more than one boss, you create more than one config file. 
  102.     . Select 'Edit Boss Config' to change things, or to quickly create a 
  103.       new config file for any other bosses.
  104. 2) After that, hit the dial button to connect to your boss.
  105.  
  106. Charon does not check your configs for errors. The information you enter in the three dialogs that follow 'Add a new Boss' has to be right to let Charon do its work, so be careful.
  107.  
  108.  
  109. 2.a. -- POINT SETUP dialog: ----------------------------------
  110.  
  111. Not much that needs explaining. Check 'Debug Stuff' if Charon gives you problems. A clumsy but informative text window will appear during the polling process.
  112. Use your own favourite modem-init string, but be sure to include E0 (zero, not the letter) at the end of the string. If you suffer from sudden disconnects, add &D0.
  113.  
  114.  
  115. 2.b. -- BOSS SETUP dialog: -----------------------------------
  116.  
  117. This dialog wants two addresses:
  118. 1) Your boss's address, which is used as the filename for the config file.
  119. 2) Your own point address. If you want to present more than one address to your boss (useful with EMSI systems only), enter them all, separated by ONLY a single space, as in the default example.
  120.  
  121. --'Try EMSI before YooHoo': keep this checked at first. If you notice that Charon mentions YooHoo anyway when calling your boss, uncheck this to speed things up. ** If connects don't work, try unchecking this option, too. **
  122.  
  123. --INBOUND Folder: where to store received files.
  124. a) using CounterPoint or Obolus: select CounterPoint's 'PKT's' folder.
  125. b) MacWoof: Select the folder Woof shows when you select 'File->import'.
  126.  
  127. --OUTBOUND Folder: Charon transmits ALL files found in this folder.
  128. a) for CounterPoint: Use Counterpoint's 'Gateway' folder,
  129. b) MacWoof: use an empty folder to store outbound packet files.
  130. c) for CounterPoint+Obolus: Obolus creates a folder called '2.281.527' (or whatever the address of your boss is) the first time it exports mail. If you cannot find this folder, create it yourself and tell Charon this is the outbound folder.  (NOTE that in Obolus itself, you enter the parent folder of 'x.xxx.xxx' as the outbound folder, as it assumes 'x.xxx.xxx' automatically. Confusing, but true.)
  131.  
  132. --OBOLUS (if used): Select the Obolus program file. This will start Obolus before your boss is called to create outbound files. NOTE: be sure _not_ to check 'run Charon' in Obolus' own config.
  133.  
  134.  
  135. 2.c. -- DECOMPRESSION Dialog: ----------------------------
  136.  
  137. Charon can call a decompression program to extract inbound mail packets after polling (system 7 only). ZipIt (ZIP) and AutoUnArj (ARJ) are the programs currently supported. (AutoUnArj is a modified version of unArj Mac, the original Mac port by Erik Larson. I can send you a copy upon request). If you use some other decompression program, select it as an AutoUnArj program, and set the file type and creator to whatever your program desires. The program will be started from Charon automatically, though you'd have to do the rest.
  138.  
  139. NOTE: Only files with the standard fido filename extensions .mo?…. .su? (i.e., 00fe5c3e.mo1) are considered to be inbound mail. Other files (received as result of a file request, for instance) are given the standard '????' file type, and are not decompressed by Charon.
  140.  
  141.  
  142. After you're done with the three dialogs, Charon lets you save the config file. The filename HAS to be the address of your boss, something like 1.362.452. Use the default name Charon offers you, or if you like, a fake address (that does not interfere with anything in the current version). This trick allows you to have more than one config file for the same boss, too.
  143.  
  144.  
  145.  
  146.  
  147. ------------------------------------------------------------------
  148.  
  149.  
  150.  
  151.  
  152. 3. Using Charon:
  153. ==============
  154.  
  155. Simply double-click the appropriate config file (put it on your desktop to have it at hand?) and hit the Dial button. Alternatively, run Charon, hit Dial, and select the config file. If you selected so, Obolus will be run before dialing out to prepare the outbound mail. 
  156. If something goes wrong, hit cmd-. to abort the poll. Aborted Zmodem transfers will be resumed automatically at the next poll. During Zmodem transfers, the effect of cmd-. may be slow in coming.
  157. If you selected a decompression program to be used, Charon deletes the compressed packets after it has ascertained decompression was successful. As a measure of precaution, you can still find deleted files in the trash can.
  158.  
  159. Freqs and File Attach messages:
  160. -----------------------------
  161. File Requests: Your message editor creates a standard .REQ file. Just put it in the outbound folder. File Attaches: Create a file attach message, and drop the attached file in the outbound folder. If you want to attach programs, convert them to MacBinary format, or use a compression program like ZipIt.
  162.  
  163. Registration:
  164. ------------
  165. Charon is freeware, so registration is just a formality. It is required nevertheless, to satisfy my own curiosity. All it takes is a few seconds, just use the Special->Registration menu item to create an automatic netmail to me.
  166. PLEASE, take the few seconds necessary to register. If you want to be kept informed about new versions, state so in your registration message. I'll then let you know when a new version is released.
  167.  
  168.  
  169. ----------------------------------------------------------------------------
  170.  
  171.  
  172.  
  173.  
  174.  
  175. 4.  Some Typical Setups:
  176. ======================
  177.  
  178. My own favourite point setup consists of Charon (to send and receive '.pkt' mail packets), AutoUnArj or ZipIt (whatever your boss uses, to decompress received packets), CounterPoint (to read and write messages), and Obolus (which enables Charon to extract outbound messages all by itself).
  179. This is, however, no more than my personal opinion. You can skip Obolus, use MacWoof as a message editor, or use any other software (I still use the beta version of a message editor running under Soft PC, for instance....). Charon just looks for packets to send, and doesn't care.
  180.  
  181.  
  182. a. Setting up CounterPoint to work with Charon:
  183. --------------------------------------------
  184. Read CounterPoint's 'MacWoof Setup' text file (or just select MacWoof as CounterPoint's mailer).  Everything's the same for Charon, BUT: 
  185. - Put Charon in the CounterPoint folder. Select Charon as
  186.    CounterPoint's System Paths '1st Launch' item.
  187. - Poll your boss using CP's 'Call Remote System' menu item. This
  188.    will export your outbound mail and start Charon. Hit Charon's
  189.    Dial button to start.
  190.  
  191. b. Setting up CounterPoint and Obolus to work with Charon:
  192. ------------------------------------------------------
  193. Simply run Charon from the finder (otherwise CP will do the exporting itself before Obolus gets a chance) any time you feel the urge to call your boss; you don't need to bother with creating/exporting .pkts. Obolus does that automatically from within Charon. 
  194.  
  195. c. Setting up MacWoof to work with Charon:
  196. -----------------------------------------
  197. Use 'Import' and 'Export' in the File menu to create outbound packets and process inbound packets. Note that Charon is useful only if your boss does _not_ use Tabby. Because it uses zmodem transfers, Charon is slightly faster than MacWoof, and offers more secure transfers (aborted transfers are resumed automatically, for instance).
  198.  
  199.  
  200. ----------------------------------------------------------------------------
  201.  
  202.  
  203.  
  204.  
  205. 5. Notes for this beta version
  206. ===========================
  207.  
  208. Thanks for trying Charon! I'm not an expert Mac programmer (God forbid), so there are bugs for sure. I wrote Charon for my own use, originally, and I do not pretend this is a professionally designed program. It is thoroughly tested by now, though, and it certainly won't eat your mail.
  209.  
  210. I decided to release a beta version now, because I will be (cruelly) separated from my Mac for some time to come - and this version is reliable enough to be of use to normal users.  At the end of this year (1993), I hope to come up with a final version.
  211.  
  212. Charon has been tested successfully with FrontDoor, Binkley, D'Bridge, Binkley ST, TheBox ST, TheBox PC, Dutchie, Intermail and Formula 1 systems. If you encounter a bug nevertheless, please save the SerialLog file and mail it to me. Also, maybe you can try if the bug can be reproduced, and look at the information that appears with Debug Stuff selected (just click on the miniature button in Charon's main window).
  213.  
  214.  
  215. Known bugs:
  216. - After a poll has been completed, Charon hangs about once 
  217.    every 300 times it is run. No damage is done, though. 
  218.    Just hit cmd-option-esc.... or try depressing option for a
  219.    few seconds. This is not reproducible on my system, so it's
  220.    rather hard to solve.
  221. - Drag-dropping something else than a proper config file
  222.    on Charon sometimes leads to a crash.
  223. - Charon's config files assume that the same volume reference
  224.    number is assigned to the same drive every time. For
  225.    removables, this is not neccessarily true.
  226. - The Box ST (v1.10) works, but uncheck 'Try EMSI'.
  227.  
  228.  
  229. Solving problems:
  230. ----------------
  231. Are your address, password and other config items entered right? If the poll proceeds OK without any mail being transferred, that's probably it. Otherwise:
  232.  
  233. A) use Debug Stuff to see what exactly is going wrong. Checking the Debug Stuff box prevents Charon from deleting the outbound packets -- they'll be sent again next time, if you do not delete them yourself.
  234.  
  235. B) Charon writes its EMSI/YooHoo chatter in a file called SerialLog. You can look at this textfile to see the stuff Charon [r]eads and [w]rites to the serial port. 
  236.  
  237. C) Maybe your boss doesn't like EMSI, force YooHoo only in the Boss Config dialog.
  238.  
  239. D) Otherwise, change the file type of the config file you use to TEXT and look at it. Maybe there's something wrong? Change it and return the file type back to NDNR. Look at the SYSTEM_NODE line especially if you connect successfully, but don't get any mail from your boss.
  240.  
  241. E) Fiddle with the following kludges (this is actually not what is going to solve your problems, but anyway): Change the STR resources 128 or 129 using ResEdit. Changing 128 from 1 to 2 gives you a different wake-up sequence, changing 129 from Y to N makes Charon appear in its B/W form on Colour QuickDraw machines. Use this if you find my colour scheme offensive.
  242.  
  243. -------------------------------------------------------------------------
  244.  
  245. ANALYSING SERIALLOG:
  246.  
  247. If you are checking the SerialLog file, EMSI connects work like this:
  248.  
  249.     Send couple of CRs
  250.     -> boss sends EMSI_REQ (if not: fall back to YoHoo, see below)
  251.     Send EMSI_INQ
  252.     Send point's EMSI_DAT. This contains the data about your setup.
  253.     -> boss sends EMSI_ACK twice
  254.     -> boss sends EMSI_DAT. Charon currently does not care about the contents.
  255.     Send EMSI_ACK twice (or more, unimportant)
  256.  
  257. After that, it is a matter of sending the mail (not in SerialLog):
  258.  
  259.     Send Zmodem outbound files    ('sz filename' in Unix terms)
  260.     Send End-of-Zmodem-send        (sz NULL)
  261.     Receive inbound files            (rz)
  262.  
  263. YooHoo goes like this:
  264.  
  265. Flush garbage  
  266. Send YOOHOO and TSYNC bytes
  267.   -> Get ENQ byte (**)
  268.   Send 0x1F, a 128 byte data packet, two CRC bytes.
  269.   -> Get ACK byte
  270.   -> Get YOOHOO (also called YooHoo/2U2)
  271.   Send ENQ
  272.   -> Get 0x1F, a 128 byte data packet, two CRC bytes.
  273.   Send ACK
  274.   Do Zmodem sending/receiving.
  275.  
  276. (**): If you get 2 'C's or NAKs in a row, that indicates a dinosaur. The boss only supports FTS-0001 Xmodem transfers, which are not built into Charon yet. As far as I know, only Tabby falls under this category.
  277.